Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add example of a decument method to the manual #1324

Closed
wants to merge 1 commit into from

Conversation

Juraj-Sulimanovic
Copy link

@Juraj-Sulimanovic Juraj-Sulimanovic commented Jan 16, 2024

Issue 1307

The example that is mentioned in the manual is missing.
I just added the example mentioned on the issue itself.

@pointlessone
Copy link
Member

Thank you for your contribution.

However, I don't think this is a very good addition. Manual describes how the method can be defined in order to get a custom document and here a default one is defined instead. I believe the manual is clear enough on the optionality of the method and its purpose. So if you want to demonstrate that then at least add some options to the document so that it was clear why the method is present in the example.

@Juraj-Sulimanovic
Copy link
Author

Thank you for your contribution.

However, I don't think this is a very good addition. Manual describes how the method can be defined in order to get a custom document and here a default one is defined instead. I believe the manual is clear enough on the optionality of the method and its purpose. So if you want to demonstrate that then at least add some options to the document so that it was clear why the method is present in the example.

Thank you for the constructive comment. I added some options in the method.
The failing spec is related to a different commit.

@pointlessone
Copy link
Member

Thank you for your contribution. This has been merged outside of GitHub.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants